home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 7 / BBS in a Box - Macintosh - Volume VII (BBS in a Box) (January 1993).iso / Files / System7 tools / F / File Kit 1.1.cpt / File Kit User Manual next >
Text File  |  1992-07-02  |  13KB  |  245 lines

  1.  
  2. File Kit Manual
  3. Version 1.1
  4.  
  5.  
  6. Contents:
  7.  
  8. 1. Welcome To File Kit
  9. 2. What’s New In This Version
  10. 3. Running File Kit
  11. 4. Volumes and the Vol Info Function
  12. 5. Files and Folders and the File Info function
  13. 6. Alias Files and the Alias Info Function
  14. 7. Comparing and Deleting Files
  15. 8. Shareware Notice
  16.  
  17.  
  18.  
  19.  
  20. 1. Welcome To File Kit
  21.  
  22. File Kit is a utility that lets you 
  23.  
  24.         • Locate the original file that an alias file describes, and display and change
  25.             system information about the original file and the alias file.
  26.  
  27.         • Examine and change all system information about all files, including file
  28.             properties that are new with system 7.0. 
  29.  
  30.         • Examine information about volumes. 
  31.  
  32.         • Open and close any file on your machine.
  33.  
  34.         • Compare and delete files.
  35.  
  36. File Kit is an essential utility for anyone who uses alias files or wants to better manage files and disks. 
  37.  
  38.  
  39.  
  40.  
  41. 2. What’s New In This Version
  42.  
  43. Since version 1.0.2, several new features have been added to File Kit:
  44.  
  45.         • File Kit displays information about alias files, including the pathname 
  46.         of the original file the alias file describes.
  47.  
  48.         • File Kit supports drag and drop under System 7.0. To 
  49.         display information about a file, you can now drag the file’s icon
  50.         over the File Kit icon in the Finder. File Kit launches and displays
  51.         information for the file.
  52.  
  53.         • The main file selection list treats alias files correctly, and now 
  54.         behaves like the standard Apple file selection dialog.
  55.  
  56.         • File Kit supports both a basic and advanced mode. In advanced mode,
  57.         file information dialogs display information that is primarily of interest to
  58.         programmers and interested power users.
  59.  
  60.  
  61.  
  62. 3. Running File Kit
  63.  
  64.     There are several ways to launch the File Kit application. You may launch File Kit by double clicking its icon in the Finder, like any other application, or if System 7.0 is installed on your machine, File Kit also supports drag and drop. To use the drag and drop feature, drag the icon of any file over the File Kit icon in the Finder. File Kit will launch and display an information window describing the file.
  65.  
  66.     However you launch it, File Kit creates the main file selection window which contains the main file list. This file list behaves like an ordinary file selection list, so it supports the arrow keys and other standard keyboard shortcuts. The main file selection window also contains buttons for File Kit’s main functions: Vol Info, File Info, Alias Info, Delete Files, and Compare Files. Each of these is described in detail below.
  67.  
  68.     File Kit also has two important options that controls how its functions. The “Show Invisible Files” option causes File Kit to display all files on your disks, even invisible files that are not normally displayed in the Finder. The “Technical Information”  option controls what information is displayed in volume and file information windows. If you select this option, then these windows will display information that is of most use to programmers and interested power users. You may turn either function on or off in the Options menu.
  69.  
  70.  
  71.  
  72.  
  73. 4. Volumes and the Vol Info Function
  74.  
  75.     The Vol Info button will display a dialog that describes the current volume. You select the current volume with the drive button in the main file selection window; it cycles through all mounted volumes. If you ask for information about the current volume, a window is created that contains the following information:
  76.  
  77.         • Name - The name of the volume
  78.  
  79.         • Total File Count - The total number of files on the volume.
  80.  
  81.         • Total Folder Count - The total number of folders on the volume.
  82.  
  83.         • Total size - The total amount of storage on this volume.
  84.  
  85.         • Space Available - The total amount of available storage on this volume.
  86.  
  87.         • Created - When the volume was last initialized.
  88.  
  89.         • Modified - When the volume was last modified. Changing any file on the volume modifies the volume.
  90.  
  91.         • Backed Up - When the volume was last backed up.
  92.  
  93.  
  94. Additionally, if you have selected the Technical Information option (described above), then this window will also display the following information:
  95.  
  96.         • Vol RefNum - This is the reference number that programmers use in File Manager traps.
  97.  
  98.         • Drive Number - This is the number of the disk drive that this volume is stored on.
  99.  
  100.         • Device Driver - This is the refNum of the device driver that controls the volume.
  101.  
  102.         • Block Size - This is the unit of allocation for storage on this volume.
  103.  
  104.  
  105.  
  106. When the Technical Information option is set, this dialog will also display which “volume attributes” apply to the selected volume. In general, a volume will only have some of the possible attributes. The possible attributes are: 
  107.  
  108.         • Startup - The volume is the startup volume. When you start your Mac, it will use the System Folder from this volume.
  109.     
  110.         • External - The volume is implemented by an external file system.
  111.  
  112.         • Bootable - The volume could be selected as a Startup volume.
  113.  
  114.         • Access Controls - The volume supports access controls for files and folders.
  115.  
  116.         • Desktop Manager - The volume supports the Desktop Manager. This means programmers can use Desktop traps for this volume.
  117.  
  118.         • BTree Manager - The volume supports the B-Tree Manager. 
  119.  
  120.         • Uses File ID’s - The volume supports the file ID’s. This means programmers can use traps that take File ID’s to operate on files on this volume.
  121.  
  122.         • CatSearch - Programmers can use the CatSearch function on this volume.
  123.  
  124.  
  125.  
  126.  
  127.  
  128. 5. Files and Folders and the File Info function
  129.  
  130.     The File Info button will display and allow you to change information about a file or folder. You can open the information window for a file or a folder in several ways:
  131.  
  132.     Select the file or folder in the main file selection window and click the
  133.      “File Info” button. 
  134.  
  135.     or double click a file name
  136.  
  137.     or selecting a file and hit the return key
  138.  
  139.  
  140. The file Info dialog displays the following information:
  141.  
  142.         • File Name - The name of the file. You may change this by typing a new name in this field and selecting the Change button.
  143.  
  144.         • Data Size - This is the logical size of the data fork of the file. Every file has two forks, the data fork and the resource fork. The total file size is the sum of the sizes of these forks. If the information window describes a folder, then this is the total size of the data fork of every file contained in the folder. 
  145.  
  146.         • Resource size - This is the logical size of the resource fork of the file. Every file has two forks, the data fork and the resource fork. The total file size is the sum of the sizes of these forks. If the information window describes a folder, then this is the total size of the resource fork of every file contained in the folder. 
  147.  
  148.  
  149.         • Created - When the file was created.
  150.  
  151.         • Modified - When the file was last modified. 
  152.  
  153.         • Backed Up - When the file was last backed up. Note that third-party backup programs may or may not set this value, but the system software does not change the value.
  154.  
  155.     Each file also has several attributes that may be set or reset with the checkboxes on the right side of the dialog. Changes to these attributes will not take place until you click the Change button, so if you make a change and then click on Cancel the file is unchanged. The following attributes are controlled by checkboxes:
  156.  
  157.         • Invisible - The file is visible in the finder
  158.  
  159.         • Locked - The file may be modified in any way. This is the same attributed that is displayed by the “Locked” checkbox when you get information about a file in the Finder.
  160.  
  161.  
  162. Additionally, if you have selected the Technical Information option (described above), then this window will also display the following attributes of a file or a folder. WARNING! These values are used by your system software to manage files.  DO NOT CHANGE THESE VALUES UNLESS YOU ARE ABSOLUTELY SURE YOU KNOW WHAT YOU ARE DOING. 
  163.  
  164.         • File Type and File Creator - This is information used by the Finder to determine what type of file this is. For example, applications have type value ‘APPL’ and control panels have type ‘cdev’. The creator is a signature, and identifies the application that created a file; and an application and any files it creates will all have the same creator value. Both the type and creator are always four letter values, but one or more letters may be a space.You may change either of these by typing a new name in this field and selecting the Change button.
  165.  
  166.         • Data fork and Resource fork - The file info dialog also displays the refNum of the data fork and resource fork. A refNum describes an open file, and programmers use refNum values in many File System operations. If the file is not open, then this field displays the message: “Closed”. There are also controls to open or close the two forks of the file. Be very careful when you close a file, the application that opened that file expects it to stay open.
  167.  
  168.     If you have set the Technical Information option, then the information window displays the following file attributes in addition to the “Locked” and “Invisible” attributes described above. Remember, changes to these attributes will not take place until you click the Change button, so if you make a change and then click the Cancel button, the file is unchanged.
  169.  
  170.         • Name Locked - The file may be renamed in the Finder. Note that you can change the name of a file in File Kit even if this attribute is set.
  171.     
  172.         • Alias - The file is an alias file. This is only used by System 7.0.
  173.  
  174.         • On Desktop - The file is displayed on the desktop in the Finder.
  175.  
  176.         • Custom Icon - The file contains a custom icon.
  177.  
  178.         • Bundle - The file contains resources to define a new type and creator bundle. 
  179.  
  180.         • Inited - This is used by the Finder to manage the display of icons in file windows.
  181.  
  182.         • Stationary - The file is a stationary file. This is only used by System 7.0.
  183.  
  184.         • Shared - The file is shared.
  185.  
  186.         • Contains Inits - The file contains startup code resources.
  187.  
  188.  
  189.  
  190. 6. Alias Files and the Alias Info Function
  191.  
  192.     If you select an alias file in the main file list, the File Info function will display information about the original file, the file that is described by the alias file. You may, however, also use the Alias Info function to display information about the alias file itself. Select an alias file in the main file selection list (the names of aliases to files and folders appear italicized) and click the mouse on the Alias Info button. File Kit will display an alias information window, which contains the name of the alias file and the pathname of the original file. The alias information window also has several buttons.
  193.  
  194.     Done - Return to the main file selection window
  195.  
  196.     Go To Original - Return to the main file selection window, but change the
  197.     current volume and folder to the location of the original file.
  198.  
  199.     Alias Info - Open a file information window (described above) describing the
  200.     alias file.
  201.  
  202.     Original Info - Open a file information window (described above) describing the
  203.     original file or folder.
  204.  
  205.  
  206.  
  207.  
  208. 7. Comparing and Deleting Files
  209.  
  210.     File Kit allows you to compare two files, to see if they are identical or not. When you select this button, File Kit will prompt you for the two files and compare them. Note that the first part of the resource fork (first 256 bytes) are ignored. Apple system software stores information about the location and other attributes in this area, and two files that appear identical to the user and for all practical purposes are identical may have different information stored here.
  211.  
  212.     To delete a file or folder, select its name in the main file list and hit the delete button. Deleting a folder deletes every file and folder contained within that folder. In any case, you will be asked if you really want to delete the file or folder because deleted files and folders cannot be recovered. 
  213.  
  214.  
  215.  
  216.  
  217.  
  218. 8. Shareware Notice
  219.  
  220.  
  221. File Kit is shareware, if you use it please send 15$ (US) to:
  222.  
  223.                 Dawson Dean, Attn: Software Publishing
  224.                 654 Blair Ave.
  225.                 Piedmont, CA 94611
  226.  
  227. To report bugs, or for more information, you may reach me online at the following addresses:
  228.  
  229. America Online: DawsonDean
  230. Internet: dawson@cs.cornell.edu
  231.  
  232. Copyright
  233. Copyright © 1991 - 92 Dawson Dean. This manual and the software described in it are copyrighted with all rights reserved.
  234.  
  235. Trademarks
  236. File Kit is a trademark of Dawson Dean
  237. Apple is a registered trademark of Apple Computer, Inc.
  238.  
  239. Limited Warranty on Media and Manual
  240. Dawson Dean makes no warranty, either explicit or implied, with respect to this software, its quality, performance, or fitness for a particular purpose. This software and manual are sold “as is”, and you the purchaser are assuming the entire risk as to its quality and performance.
  241.  
  242. In no event will Dawson Dean be liable for direct, indirect, special, incidental, or consequential damages resulting from any defect in the software or its documentation. In particular, Dawson Dean shall have no liability for any damage to programs or data used with this product, including the cost of recovering or repairing such programs or data.
  243.  
  244. The warranty and remedies set forth above are exclusive and in lieu of all others, oral or written, express or implied. 
  245.